API Explorer

⯆

API Explorer

My Collections

Account Access Consents
- Create Account Access Consents
- Get Account Access Consents by ConsentId
- Update Account Access Consent Status by ConsentId
Accounts
- Get Account by AccountId
- Get Accounts
Balances
- Get Accounts Balances by AccountId
- Get Balances
Beneficiaries
- Get Accounts Beneficiaries by AccountId
- Get Beneficiaries
Direct Debits
- Get Accounts Direct Debits by AccountId
- Get Direct Debits
Domestic Future Dated Payment Consents
- Create Domestic Future Dated Payment Cancellation Consents
- Create Domestic Future Dated Payment Consents
- Get Domestic Future Dated Payment Cancellation Consents by ConsentId
- Get Domestic Future Dated Payment Consents by ConsentId
Domestic Future Dated Payments
- Create Domestic Future Dated Payments
- Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId
- Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
- Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
Domestic Payments
- Create Domestic Payments
- Get Domestic Payment details by DomesticPaymentId
- Get Domestic Payments by DomesticPaymentId
Domestic Payments Consents
- Create Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation by ConsentId
- Get Domestic Payment Consents by ConsentId
Dynamic Resource Doc
- A test endpoint
Event Notification
- The ASPSP to send an event-notification resource to a TPP
File Payment Consents
- Create File Payment Consents
- Create File Payment Consents File by ConsentId
- Get File Payment Consents File by ConsentId
- Get File Payment Consents by ConsentId
File Payments
- Create File Payments
- Get File Payment Details by FilePaymentId
- Get File Payments Report File by FilePaymentId
- Get File Payments by FilePaymentId
Future Dated Payments
- Get Accounts Future Dated Payments by AccountId
- Get Future Dated Payments
International Payment Consents
- Create International Payment Consents
- Get International Payment Consents Funds Confirmation by ConsentId
- Get International Payment Consents by ConsentId
International Payments
- Create International Payments
- Get International Payment Details by InternationalPaymentId
- Get International Payments by InternationalPaymentId
Offers
- Get Accounts Offers by AccountId
- Get Offers
Parties
- Get Accounts Parties by AccountId
- Get Accounts Party by AccountId
- Get Party
Standing Orders
- Get Accounts Standing Orders by AccountId
- Get Standing Orders
Statements
- Get Accounts Statement Tranactions by AccountId and StatementId
- Get Accounts Statement by AccountId and StatementId
- Get Accounts Statements File by AccountId and StatementId
- Get Accounts Statements by AccountId
- Get Statements
Supplementary Account Info
- Get Accounts Supplementary Account Info by AccountId
Transactions
- Get Accounts Trabnsactions by AccountId
- Get Transactions
_Authority Data Request
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(000202)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(ADOPEM)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(APAP)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(BANRESERVAS)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(BHD LEON)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(CONFISA)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(POPULAR)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(SCOTIABANK)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(brrd 01)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Foo Bar
- Create new Foo Bar
- Delete Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Update Foo Bar
_Obp Activity(trn.34.my.strings)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity

Log off

BAHRAIN-OBFv1.0.0 (118 APIs)

API Host: https://ifcsandbox.openbankproject.com

Create International Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "Debtor":{
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":"Actual",
      "ContractIdentification":"ContractIdentification",
      "UnitCurrency":"UnitCurrency"
    },
    "Refund":{
      "Account":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "Agent":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":{
          
        }
      },
      "Creditor":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Name":"Name"
      }
    },
    "Charges":[{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    },{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    }],
    "InternationalPaymentId":"InternationalPaymentId",
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":{
          
        }
      },
      "DebtorAccount":{
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "InstructionIdentification":"InstructionIdentification",
      "CreditorAccount":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "ChargeBearer":{
        
      },
      "Purpose":"Purpose",
      "ExtendedPurpose":"ExtendedPurpose",
      "InstructionPriority":"Normal",
      "LocalInstrument":{
        
      },
      "RemittanceInformation":{
        "RemittanceDescription":"RemittanceDescription",
        "Reference":"Reference"
      },
      "DestinationCountryCode":"DestinationCountryCode",
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "RateType":"Actual",
        "ContractIdentification":"ContractIdentification",
        "UnitCurrency":"UnitCurrency"
      },
      "Creditor":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      }
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: BAHRAIN-OBFv1.0.0, function_name: by internationalPaymentsPost, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentsPost Tags: International Payments, Mocked-Data,

Get International Payment Details by InternationalPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

INTERNATIONAL_PAYMENT_ID: INTERNATIONAL_PAYMENT_ID

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "PaymentStatus":[{
      "PaymentTransactionId":"PaymentTransactionId",
      "Status":"Accepted",
      "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
      "StatusDetail":{
        "Status":"Status",
        "LocalInstrument":{
          
        },
        "StatusReason":"Cancelled",
        "StatusReasonDescription":"StatusReasonDescription"
      }
    },{
      "PaymentTransactionId":"PaymentTransactionId",
      "Status":"Accepted",
      "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
      "StatusDetail":{
        "Status":"Status",
        "LocalInstrument":{
          
        },
        "StatusReason":"Cancelled",
        "StatusReasonDescription":"StatusReasonDescription"
      }
    }]
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: BAHRAIN-OBFv1.0.0, function_name: by internationalPaymentsInternationalPaymentIdPaymentDetailsGet, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentsInternationalPaymentIdPaymentDetailsGet Tags: International Payments, Mocked-Data,

Get International Payments by InternationalPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

INTERNATIONAL_PAYMENT_ID: INTERNATIONAL_PAYMENT_ID

JSON response body fields:

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "First":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou"
  },
  "Data":{
    "Status":"AcceptedCreditSettlementCompleted",
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "Debtor":{
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":"Actual",
      "ContractIdentification":"ContractIdentification",
      "UnitCurrency":"UnitCurrency"
    },
    "Refund":{
      "Account":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "Agent":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":{
          
        }
      },
      "Creditor":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Name":"Name"
      }
    },
    "Charges":[{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    },{
      "Type":{
        
      },
      "Amount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      },
      "ChargeBearer":{
        
      }
    }],
    "InternationalPaymentId":"InternationalPaymentId",
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "CreditorAgent":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":{
          
        }
      },
      "DebtorAccount":{
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "InstructionIdentification":"InstructionIdentification",
      "CreditorAccount":{
        "Identification":{
          
        },
        "SchemeName":{
          
        },
        "Name":"Name"
      },
      "ChargeBearer":{
        
      },
      "Purpose":"Purpose",
      "ExtendedPurpose":"ExtendedPurpose",
      "InstructionPriority":"Normal",
      "LocalInstrument":{
        
      },
      "RemittanceInformation":{
        "RemittanceDescription":"RemittanceDescription",
        "Reference":"Reference"
      },
      "DestinationCountryCode":"DestinationCountryCode",
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "RateType":"Actual",
        "ContractIdentification":"ContractIdentification",
        "UnitCurrency":"UnitCurrency"
      },
      "Creditor":{
        "PostalAddress":{
          "CountrySubDivision":{
            
          },
          "StreetName":{
            
          },
          "Department":{
            
          },
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":{
            
          },
          "TownName":{
            
          },
          "Country":{
            
          },
          "SubDepartment":{
            
          },
          "AddressType":{
            
          },
          "PostCode":{
            
          }
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Amount":{
          
        },
        "Currency":{
          
        }
      }
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: BAHRAIN-OBFv1.0.0, function_name: by internationalPaymentsInternationalPaymentIdGet, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentsInternationalPaymentIdGet Tags: International Payments, Mocked-Data,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

BAHRAIN-OBFv1.0.0 (118 APIs)

Create International Payments

Get International Payment Details by InternationalPaymentId

Get International Payments by InternationalPaymentId